﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>&#19968;&#65292;&#23433;&#35013;Docfx </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="&#19968;&#65292;&#23433;&#35013;Docfx ">
    <meta name="generator" content="docfx 2.48.0.0">
    
    <link rel="shortcut icon" href="../favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    
    
    
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="">

<p>[摘要]</p>
<p>这是我编写的一个 Docfx 文档自动生成工具，只要写好 Markdown 文档，使用此工具可为目录、文件快速生成配置，然后直接使用 docfx 运行即可。</p>
<p><a href="https://github.com/whuanle/CZGL.DocfxBuild.Yml/releases/tag/1.0">https://github.com/whuanle/CZGL.DocfxBuild.Yml/releases/tag/1.0</a></p>
<h2 id="一安装docfx">一，安装Docfx</h2>
<p>下载地址 <a href="https://github.com/dotnet/docfx/releases">https://github.com/dotnet/docfx/releases</a></p>
<p>下载后解压压缩包，记录好目录路径。</p>
<p>Win 搜索 “环境变量”，会出现 “编辑系统环境变量”。</p>
<p>然后 ↓</p>
<p><img src="https://obs1.whuanle.cn/markdown/CZGL.DocfxBuild.Yml/1562330330(1).png" alt=""></p>
<p>新建一个目录，用来存放 markdown 文件。打开目录，按住 <kbd>Shift</kbd> + <kbd>鼠标右键</kbd> ，打开 Powershell 。</p>
<p>两个命令</p>
<pre><code class="lang-powershell">docfx init -q
docfx docfx_project\docfx.json --serve   // 以实际路径为准
docfx server _site -p&lt;port&gt;
</code></pre>
<h2 id="二-创建-docfx-项目">二， 创建 Docfx 项目</h2>
<p>使用此命令在目录下初始一个 docfx 项目</p>
<pre><code>docfx init -q
</code></pre>
<p>-q 这个参数表示忽略询问，直接生成。如果需要自定义配置，可取消 -q 这个参数。</p>
<p>打开 docfx_project 文件夹，目录结构如下：</p>
<pre><code>docfx_project 
.
├── api
│   ├── index.md
│   └── toc.yml
├── apidoc
├── articles
│   ├── intro.md
│   └── toc.yml
├── docfx.json
├── images
├── index.md
├── src
└── toc.yml
</code></pre>
<h5 id="为代码创建-api-文档">为代码创建 API 文档</h5>
<p>src 目录用来存放你需要生成文档的项目，直接把整个项目(解决方案)放进去即可。</p>
<p><img src="https://obs1.whuanle.cn/markdown/CZGL.DocfxBuild.Yml/1562332845(1).png" alt=""></p>
<p>生成文档</p>
<pre><code> docfx docfx_project\docfx.json --serve
</code></pre>
<p>预览</p>
<p><img src="https://obs1.whuanle.cn/markdown/CZGL.DocfxBuild.Yml/1562333383(1).png" alt=""></p>
<p>对于 项目，可以快速生成对象文档、代码文档。</p>
<p>这里有关于 REST API 生成文档的详细方法</p>
<p><a href="https://dotnet.github.io/docfx/tutorial/intro_rest_api_documentation.html">https://dotnet.github.io/docfx/tutorial/intro_rest_api_documentation.html</a></p>
<h2 id="三-文字文档">三， 文字文档</h2>
<p>文字文档使用 markdown 文件编写，存放位置 articles 。</p>
<pre><code>    ├── intro.md
    └── toc.yml
</code></pre>
<p>这两个文件是默认的， toc.yml 由于默认生成目录结构，intro.md 是打开文档是默认看到的，可以理解为封面内容。例如 Github 仓库的 Readme.md 。</p>
<p>为了生成多级目录，建议每个目录有应该有一个 toc.yml 文件。</p>
<p>最简单的语法</p>
<pre><code class="lang-yaml">- name: xxx
  href: xxxx
</code></pre>
<p>用于生成目录结构详细、文档文件，href 可以是 目录、 .md 文件、.yml 文件。</p>
<p>但 href 为 .yml 是，会生成目录结构。</p>
<p>使用</p>
<pre><code>  items:
    - name: Topic2_1
      href: Topic2_1.md
      ...
      ...
</code></pre>
<p>也可以生成层次结构。</p>
<pre><code class="lang-yaml">  homepage: index.md

</code></pre>
<p>用来生成首页文件，对于子目录，用处不大。</p>
<p>用来测试的文件和目录</p>
<pre><code>.
└── articles
    ├── a
    │   ├── a
    │   ├── a.md
    │   ├── b
    │   ├── b.md
    │   ├── c
    │   ├── c.md
    │   ├── d
    │   └── d.md
    ├── b
    │   ├── a
    │   ├── a.md
    │   ├── b
    │   ├── b.md
    │   ├── c
    │   ├── c.md
    │   ├── d
    │   └── d.md
    ├── c
    │   ├── a
    │   ├── a.md
    │   ├── b
    │   ├── b.md
    │   ├── c
    │   ├── c.md
    │   ├── d
    │   └── d.md
    ├── d
    │   ├── a
    │   ├── a.md
    │   ├── b
    │   ├── b.md
    │   ├── c
    │   ├── c.md
    │   ├── d
    │   └── d.md
    ├── intro.md
    └── toc.yml

</code></pre>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
              <!-- <p><a class="back-to-top" href="#top">Back to top</a><p> -->
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
